NeighborRange default for hopping range #89
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This implements a new default behavior for the
range
keyword inhopping
. This default used to be hard-coded torange = 1
, which is rather arbitrary and can lead to surprises, as discussed in #85.With this PR, the default for
hopping
isrange = nrange(1)
, wherenrange(n)
creates aNeighborRange
object that represents the distance between nᵗʰ-order nearest-neighbors of a lattice's sites.nrange
is a new exported function.The default behavior for something like
hopping(1)
then corresponds to nearest neighbors only (nrange(1)
)We can also choose to specify hoppings up to second-nearest neighbors with
Since #87 we can also specify (inclusive) range intervals. This ability extends to
NeighborRanges
now.Apart from
nrange(n::Int)
,nrange
has a second methodnrange(n::Int, lat::AbstractLattice)
that computes said distance for a given lattice. So, for example